/*
 *  SPAGL Copyright (C) 2008 Sam Pottinger
 *  This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser 
 *  General Public License as published by the Free Software Foundation; either version 2.1 of the License, or 
 *  (at your option) any later version. This library is distributed in the hope that it will be useful, but 
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 *  See the GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License along with this library; if not, 
 *  write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */

package spagcore;

/**
 * An interface to standardize the use of image-capable widgets
 * @author Sam Pottinger
 */
public interface SpaglImageCapable {
	
	/**
	 * Gets the SpaglImage as a {@link SpaglCoreImage} that is used by this widget
	 * @return The image associated with this widget as a SpaglCoreImage
	 */
	public SpaglCoreImage getImage();
	
	/**
	 * Sets the image to be used by this widget
	 * @param newImage The {@link SpaglCoreImage}-compatable image object to be used by this widget
	 */
	public void setImage(SpaglCoreImage newImage); // Set the image for the widget
	
	/**
	 * Sets the image to be used by this widget
	 * @param newImage The {@link SpaglCoreImage}-compatable image object to be used by this widget
	 * @param dispose True if the image should be disposed immediately (experimental)
	 */
	public void setImage(SpaglCoreImage newImage, boolean dispose); // Set the image for the widget

}
